home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cato / Xm / XmClipboardInquirePendingItems.z / XmClipboardInquirePendingItems
Text File  |  1998-10-20  |  7KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeePPPPeeeennnnddddiiiinnnnggggIIIIttttUUUUeeeeNNNNmmmmIIIIssssXXXX((((3333SSSSXXXXXXXXyyyymmmm))))ssssCCCCttttlllleeeeiiiimmmmppppbbbbVVVVooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeePPPPeeeennnnddddiiiinnnnggggIIIItttteeeemmmmssss((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeePPPPeeeennnnddddiiiinnnnggggIIIItttteeeemmmmssss - A clipboard function that
  10.           returns a list of _d_a_t_a__i_d/_p_r_i_v_a_t_e__i_d pairs
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////XXXXmmmm....hhhh>>>>
  14.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////CCCCuuuuttttPPPPaaaasssstttteeee....hhhh>>>>
  15.  
  16.           iiiinnnntttt XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeePPPPeeeennnnddddiiiinnnnggggIIIItttteeeemmmmssss ((((_d_i_s_p_l_a_y, _w_i_n_d_o_w, _f_o_r_m_a_t__n_a_m_e,
  17.                     _i_t_e_m__l_i_s_t, _c_o_u_n_t))))
  18.                DDDDiiiissssppppllllaaaayyyy          * _d_i_s_p_l_a_y;;;;
  19.                WWWWiiiinnnnddddoooowwww           _w_i_n_d_o_w;;;;
  20.                cccchhhhaaaarrrr             * _f_o_r_m_a_t__n_a_m_e;;;;
  21.                XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddPPPPeeeennnnddddiiiinnnnggggLLLLiiiisssstttt* _i_t_e_m__l_i_s_t;;;;
  22.                uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnngggg    * _c_o_u_n_t;;;;
  23.  
  24.  
  25.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  26.           This page documents version 1.2 of the Motif library.
  27.  
  28.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  29.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeePPPPeeeennnnddddiiiinnnnggggIIIItttteeeemmmmssss returns a list of
  30.           _d_a_t_a__i_d/_p_r_i_v_a_t_e__i_d pairs for the specified format name.  A
  31.           data item is considered pending if the application
  32.           originally passed it by name, the application has not yet
  33.           copied the data, and the item has not been deleted from the
  34.           clipboard.  The application is responsible for freeing the
  35.           memory provided by this function to store the list.  To free
  36.           the memory, call XXXXttttFFFFrrrreeeeeeee.
  37.  
  38.           This function is used by an application when exiting, to
  39.           determine if the data that is passed by name should be sent
  40.           to the clipboard.
  41.  
  42.  
  43.           _d_i_s_p_l_a_y     Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure
  44.                       that was returned in a previous call to
  45.                       XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or XXXXttttDDDDiiiissssppppllllaaaayyyy.
  46.  
  47.           _w_i_n_d_o_w      Specifies a widget's window ID that relates the
  48.                       application window to the clipboard.  The
  49.                       widget's window ID can be obtained by using
  50.                       XXXXttttWWWWiiiinnnnddddoooowwww.  The same application instance should
  51.                       pass the same window ID to each of the clipboard
  52.                       functions that it calls.
  53.  
  54.           _f_o_r_m_a_t__n_a_m_e Specifies a string that contains the name of the
  55.                       format for which the list of data ID/private ID
  56.                       pairs is to be obtained.
  57.  
  58.           _i_t_e_m__l_i_s_t   Specifies the address of the array of data
  59.                       ID/private ID pairs for the specified format
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeePPPPeeeennnnddddiiiinnnnggggIIIIttttUUUUeeeeNNNNmmmmIIIIssssXXXX((((3333SSSSXXXXXXXXyyyymmmm))))ssssCCCCttttlllleeeeiiiimmmmppppbbbbVVVVooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeePPPPeeeennnnddddiiiinnnnggggIIIItttteeeemmmmssss((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                       name.  This argument is a type
  75.                       XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddPPPPeeeennnnddddiiiinnnnggggLLLLiiiisssstttt.  The application is
  76.                       responsible for freeing the memory provided by
  77.                       this function for storing the list.
  78.  
  79.           _c_o_u_n_t       Specifies the number of items returned in the
  80.                       list.  If there is no data for the specified
  81.                       format name, or if there is no item on the
  82.                       clipboard, this argument equals zero.
  83.  
  84.  
  85.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  86.           CCCClllliiiippppbbbbooooaaaarrrrddddSSSSuuuucccccccceeeessssssss
  87.                       The function is successful.
  88.  
  89.           CCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkkeeeedddd
  90.                       The function failed because the clipboard was
  91.                       locked by another application.  The application
  92.                       can continue to call the function again with the
  93.                       same parameters until the lock goes away.  This
  94.                       gives the application the opportunity to ask if
  95.                       the user wants to keep trying or to give up on
  96.                       the operation.
  97.  
  98.  
  99.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  100.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy((((3333XXXX)))).
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.